[Feature] Documentation on the --config flag when using init
#287
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
neelasha23
reviewed
Oct 4, 2024
doc/user-guide/cli.md
Outdated
| @@ -88,6 +88,14 @@ Then, execute: | |||
| ploomber-cloud deploy | |||
| ``` | |||
|
|
|||
| **Optional Configuration**: | |||
| You can use the `--config` flag with the `ploomber-cloud init --from-existing` command to specify a custom name for the configuration file instead of the default `ploomber-cloud.json`. When using this flag, only the file name will be considered, regardless of any specified path. For example: | |||
There was a problem hiding this comment.
Please add a reference to this section
There was a problem hiding this comment.
This is not clear: ..and any specified path is ignored.. Also, I meant in this section you can add a link something like, `Refer to this section to learn more about switching configurations. You can look at other files to see how we link sections from the same file.
There was a problem hiding this comment.
Just to be sure, is this what you had in mind ? b525cfd
- Precise that --config can but use with a path. not just a name
- Refer to the config section to know more about switching the config file
neelasha23
reviewed
Oct 7, 2024
doc/user-guide/cli.md
Outdated
|
|
||
| ```sh | ||
| # create the config file in ploomber-cloud.dev.json | ||
| ploomber-cloud init --config ploomber-cloud.dev.json | ||
|
|
||
| # deploy using the dev config | ||
| ploomber-cloud deploy --config ploomber-cloud.dev.json | ||
| ploomber-cloud deploy --config ./config/ploomber-cloud.dev.json |
There was a problem hiding this comment.
Why did we add ./config/..?
There was a problem hiding this comment.
As an example of a path. We can leave it as it was
There was a problem hiding this comment.
Suggested change
| ploomber-cloud deploy --config ./config/ploomber-cloud.dev.json | |
| ploomber-cloud deploy --config ploomber-cloud.dev.json |
neelasha23
approved these changes
Oct 7, 2024
edublancas
approved these changes
Oct 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Close: https://github.com/ploomber/cli/pull/146#discussion_r1787222055
📚 Documentation preview 📚: https://ploomber-doc--287.org.readthedocs.build/en/287/